Quill.js delta payload for arrayNode events by daesunp · Pull Request #26677 · microsoft/FluidFramework

daesunp · 2026-03-09T18:35:16Z

Description

Adds quill.js delta event payload for arraynodes.

Copilot

Pull request overview

This PR adds a Quill-style delta payload for array-node nodeChanged events by plumbing sequence-field mark data through the delta visitation/eventing pipeline and exposing it as ArrayNodeDeltaOp[] on NodeChangedData.

Changes:

Introduces ArrayNodeDeltaOp and adds NodeChangedData.delta for array nodes, updating TreeChangeEventsBeta.nodeChanged typing accordingly.
Extends internal delta visitation (DeltaVisitor.fieldMarks) and anchor/kernel events (childrenChangedAfterBatch.fieldMarks) to carry ordered field mark sequences through buffering.
Adds/updates unit tests and introduces a new fuzz suite to validate array delta behavior.

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/framework/fluid-framework/api-report/fluid-framework.legacy.beta.api.md	API report updates to include `ArrayNodeDeltaOp` and `NodeChangedData.delta` typing.
packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md	Same as above for beta report.
packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md	Same as above for alpha report.
packages/dds/tree/src/test/simple-tree/core/treeNodeKernel.spec.ts	Adds tests for array `nodeChanged` delta presence/semantics and move delta payloads.
packages/dds/tree/src/test/simple-tree/api/treeNodeApi.spec.ts	Adds API-level tests validating concrete `ArrayNodeDeltaOp` sequences for array operations.
packages/dds/tree/src/test/shared-tree/fuzz/arrayNodeDelta.fuzz.spec.ts	New fuzz suite intended to validate delta-driven shadow maintenance across clients/rebase.
packages/dds/tree/src/simple-tree/index.ts	Re-exports `ArrayNodeDeltaOp` from the simple-tree entrypoint.
packages/dds/tree/src/simple-tree/core/unhydratedFlexTree.ts	Ensures unhydrated `childrenChangedAfterBatch` emits an (empty) `fieldMarks` map.
packages/dds/tree/src/simple-tree/core/treeNodeKernel.ts	Buffers/flushes `fieldMarks` alongside `changedFields`, invalidating marks on multi-batch collisions.
packages/dds/tree/src/simple-tree/api/treeNodeApi.ts	Defines `ArrayNodeDeltaOp`, converts `DeltaMark[]` → ops, and emits `delta` for array `nodeChanged`.
packages/dds/tree/src/simple-tree/api/treeBeta.ts	Updates `NodeChangedData`/`TreeChangeEventsBeta` typings + docs to surface array delta.
packages/dds/tree/src/simple-tree/api/index.ts	Re-exports `ArrayNodeDeltaOp` from the API barrel.
packages/dds/tree/src/index.ts	Re-exports `ArrayNodeDeltaOp` from the package root.
packages/dds/tree/src/core/tree/visitorUtils.ts	Extends combined visitors to forward the new optional `fieldMarks` hook.
packages/dds/tree/src/core/tree/visitDelta.ts	Adds `DeltaVisitor.fieldMarks` and calls it once per field during the detach pass.
packages/dds/tree/src/core/tree/anchorSet.ts	Extends `childrenChangedAfterBatch` payload to include `fieldMarks` captured from delta visitation.
packages/dds/tree/api-report/tree.legacy.beta.api.md	API report updates for new type/export and event payload typing.
packages/dds/tree/api-report/tree.beta.api.md	Same as above for beta report.
packages/dds/tree/api-report/tree.alpha.api.md	Same as above for alpha report.

You can also share your feedback on Copilot code review. Take the survey.

packages/dds/tree/src/test/shared-tree/fuzz/arrayNodeDelta.fuzz.spec.ts

+	  }
+	| { readonly type: "synchronize" };


packages/dds/tree/src/test/shared-tree/fuzz/arrayNodeDelta.fuzz.spec.ts

+	for (const op of delta) {
+		switch (op.type) {
+			case "retain": {
+				result.push(...shadow.slice(srcIdx, srcIdx + op.count));
+				srcIdx += op.count;
+				break;


github-actions · 2026-03-16T17:43:15Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  257792 links
    1822 destination URLs
    2063 URLs ignored
       0 warnings
       0 errors

alex-pardes · 2026-03-16T17:55:55Z

packages/dds/tree/src/core/tree/visitDelta.ts

@@ -372,6 +392,9 @@ function visitFieldMarks(
 	if (fields !== undefined) {
 		for (const [key, field] of fields) {
 			visitor.enterField(key);
+			if (config.isFirstPass) {
+				visitor.fieldMarks?.(key, field.marks);


Instead of adding the isFirstPass flag, can we just put this line into the beginning of the attachPass function?

I meant detachPass.

alex-pardes · 2026-03-16T22:10:04Z

packages/dds/tree/src/simple-tree/api/treeNodeApi.ts

+			// Replacement: content removed and new content attached in the same position.
+			// The `Delta.Mark` format allows both to be set simultaneously (e.g. when a slot's
+			// content is atomically swapped), even though the sequence-field encoder does not
+			// currently emit such marks for array (EmptyKey) fields.  Handle it defensively.


The terminology here doesn't make sense to me. It seems sufficient to say that this case should be unreachable (because sequence field never produces a replace delta mark), but is handled anyway.

alex-pardes · 2026-03-16T22:11:24Z

packages/dds/tree/src/simple-tree/api/treeNodeApi.ts

+		if (mark.attach !== undefined && mark.detach !== undefined) {
+			// Replacement: content removed and new content attached in the same position.
+			// The `Delta.Mark` format allows both to be set simultaneously (e.g. when a slot's
+			// content is atomically swapped), even though the sequence-field encoder does not
+			// currently emit such marks for array (EmptyKey) fields.  Handle it defensively.
+			ops.push({ type: "remove", count: mark.count });
+			ops.push({ type: "insert", count: mark.count });
+		} else if (mark.attach !== undefined) {
+			ops.push({ type: "insert", count: mark.count });
+		} else if (mark.detach === undefined) {
+			// Neither attach nor detach: elements retained (may have nested changes in mark.fields).
+			ops.push({ type: "retain", count: mark.count });
+		} else {
+			ops.push({ type: "remove", count: mark.count });
+		}


It looks like this could just have one block for mark.detach !== undefined, followed by a block for mark.attach !== undefined.

alex-pardes · 2026-03-16T22:51:59Z

packages/dds/tree/src/simple-tree/core/treeNodeKernel.ts

-		arg?: {
-			changedFields: ReadonlySet<FieldKey>;
-		},
+		...args:


What is the purpose of this change?

daesunp added 3 commits March 9, 2026 18:25

updated tests, added fixes, updated docs

bf64461

update tests, docs, refactor

0116d26

Add fuzz test, update docs

1d92563

daesunp marked this pull request as ready for review March 16, 2026 17:33

daesunp requested review from a team as code owners March 16, 2026 17:33

Copilot AI review requested due to automatic review settings March 16, 2026 17:33

Copilot started reviewing on behalf of daesunp March 16, 2026 17:34 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

daesunp changed the title ~~updated tests, added fixes, updated docs~~ Quill.js delta payload for arrayNode events Mar 16, 2026

alex-pardes reviewed Mar 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quill.js delta payload for arrayNode events#26677

Quill.js delta payload for arrayNode events#26677
daesunp wants to merge 3 commits intomicrosoft:mainfrom
daesunp:quill-payload

daesunp commented Mar 9, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions bot commented Mar 16, 2026

Uh oh!

alex-pardes Mar 16, 2026

Uh oh!

alex-pardes Mar 16, 2026

Uh oh!

alex-pardes Mar 16, 2026

Uh oh!

alex-pardes Mar 16, 2026

Uh oh!

alex-pardes Mar 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

daesunp commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions bot commented Mar 16, 2026

linkcheck output

Uh oh!

alex-pardes Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

alex-pardes Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

alex-pardes Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

alex-pardes Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

alex-pardes Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

daesunp commented Mar 9, 2026 •

edited

Loading